Get Users
Get Users
Path Parameters
Response
idstring
Unique ID of Admin User.
mfaEnabledstring
A boolean value indicating whether the mfa is enabled (true) or not (false).
createdTimestampnumber
Timestamp indicating when the user is created.
usernamestring
The username of the User.
enabledboolean
A boolean value indicating whether the user is enabled (true) or disabled (false).
totpboolean
A boolean value indicating whether the user is configured for time based otp (true) or not (false).
emailVerifiedboolean
A boolean value indicating whether the email is verified (true) or not (false).
firstNamestring
The first name of the user
lastNamestring
The last name of the user
emailstring
the email id of the user
skipSendingEmailboolean
A boolean value indicating whether the user will get email (false) or not (false).
userInviteStatusstring
The invite status of the user
inviteClientIdstring
The invite client id of the user
attributesobject
The attribute associated with user
disableableCredentialTypesarray
List of disabled credentials
requiredActionsarray
A set of actions that must be completed by the user during the authentication process
notBeforenumber
It is a timestamp attribute associated with a user. It represents the point in time before which certain operations or actions related to the user are not allowed.
accessobject
Access information of the user
accountCreatorboolean
A boolean value indicating whether the user is account creator (true) or not (false).
[
{
"id": "eca9fdb5-949c-429d-9dc0-6d87cd35b75f",
"mfaEnabled": false,
"createdTimestamp": 1703239574215,
"username": "grootuser1",
"enabled": true,
"totp": false,
"emailVerified": false,
"firstName": "groot",
"lastName": "user1",
"email": "grootuser1@gmail.com",
"skipSendingEmail": false,
"userInviteStatus": "Invited",
"inviteClientId": "sso",
"attributes": {
"syncedFrom": [
"okta_ws"
]
},
"disableableCredentialTypes": [],
"requiredActions": [],
"notBefore": 0,
"access": {
"manageGroupMembership": true,
"winlogonUser": false,
"view": true,
"mapRoles": true,
"impersonate": true,
"winlogonAdmin": false,
"manage": true
},
"accountCreator": false
},
{
"id": "638100be-d5db-4182-ab08-9cc5721be561",
"mfaEnabled": false,
"createdTimestamp": 1703239572790,
"username": "qwerty@gmail.com",
"enabled": true,
"totp": false,
"emailVerified": false,
"firstName": "qwerty",
"lastName": "",
"email": "qwerty@gmail.com",
"skipSendingEmail": false,
"userInviteStatus": "Invited",
"inviteClientId": "sso",
"attributes": {
"syncedFrom": [
"okta_ws"
]
},
"disableableCredentialTypes": [],
"requiredActions": [],
"notBefore": 0,
"access": {
"manageGroupMembership": true,
"winlogonUser": false,
"view": true,
"mapRoles": true,
"impersonate": true,
"winlogonAdmin": false,
"manage": true
},
"accountCreator": false
}
]
| HTTP STATUS CODE SUMMARY | ||
|---|---|---|
| 200 - OK | Successfully done. | |
| 201 - OK | Successfully created. | |
| 400 - Bad Request | The request was unacceptable, often due to missing a required parameter. | |
| 401 - Unauthorized | Unauthorized access try with correct access. | |
| 402 - Request Failed | The parameters were valid but the request failed. | |
| 403 - Forbidden | The Application doesn't have permissions to perform the request. | |
| 404 - Not Found | The requested resource doesn't exist | |
| 500 - Server Errors | Something went wrong on ezto auth's end. (These are rare.) | |
| 503 - Server Errors | Service temporarily unavailable |